This function returns information about a subsetted time period for a particular field. Because of differences in number type and geolocation mapping, a given time period will give different values for the dimensions and size for various fields.
Note: Array ordering of variables used or returned by this routine changed in IDL 5.5. Programs written for versions of this routine prior to IDL 5.5 may need to be modified to work correctly with the current version.
Result = EOS_SW_PERIODINFO(swathID, periodID, fieldname, ntype, rank, dims, size)
Returns SUCCEED (0) if successful and FAIL (–1) otherwise.
Swath id (long) returned by EOS_SW_CREATE or EOS_SW_ATTACH.
Period id (long) returned by EOS_SW_DEFTIMEPERIOD.
Field to subset (string).
A named variable that will contain the number type of field (long).
A named variable that will contain the rank of field (long).
A named variable that will contain the dimensions of subset period (long).
A named variable that will contain the size in bytes of subset period (long).
None
In this example, we retrieve information about the time period defined in EOS_SW_DEFTIMEPERIOD for the Spectra field:
; Get size in bytes of time period for "Spectra" field
status = EOS_SW_PERIODINFO(EOS_SW_id, periodID, $
"Spectra", ntype, rank, dims, size)
|
5.2 |
Introduced |